IApi.StartFromConfiguration method

Starts the KINGSTAR Subsystem using the configuration file created by KINGSTAR Configuration Tool.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

C#VB
KsCommandStatus StartFromConfiguration(
       string Configuration
)
Function StartFromConfiguration(
       Configuration As String
) As KsCommandStatus

Parameters

Configuration

Type: string

The location of the .kst file, which is created using KINGSTAR Configuration Tool.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

Replaces the methods used to create, configure, and start the KINGSTAR Subsystem and the axes. The method is synchronous and will return once the Subsystem and axes are configured.

Usable EtherCAT states

ecatOffline

Examples

C#
N/A

See also

IApi Interface

IntervalZero.KINGSTAR.Base.Api Namespace